
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>enable-secure-admin</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>enable-secure-admin</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="enable-monitoring.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="enable-secure-admin-internal-user.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="enable-secure-admin-1"></a><a id="GSRFM00129"></a><a id="enable-secure-admin"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_enable_secure_admin">enable-secure-admin</h2>
<div class="sectionbody">
<div class="paragraph">
<p>enables secure admin (if it is not already enabled), optionally changing
the alias used for DAS-to-instance admin messages or the alias used for
instance-to-DAS admin messages.</p>
</div>
<div id="sthref1128" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] enable-secure-admin [--help]
[--adminalias=alias]
[--instancealias=alias]</code></pre>
</div>
</div>
<div id="sthref1129" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>enable-secure-admin</code> subcommand causes the DAS and the instances in
the domain to use SSL certificates for encrypting the messages they send
to each other. This subcommand also allows the DAS to accept
administration messages from remote admin clients such as the asadmin
utility and IDEs.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>You must restart any running servers in the domain after you enable or
disable secure admin. It is simpler to enable or disable secure admin
with only the DAS running, then restart the DAS, and then start any
other instances.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>By default, when secure admin is enabled the DAS and the instances use
these SSL certificates to authenticate to each other as security
"principals" and to authorize admin access. The <code>--asadminalias</code> value
indicates to the DAS which SSL certificate it should use to identify
itself to the instances. The <code>--instancealias</code> value determines for
instances which SSL certificate they should use to identify themselves
to the DAS.</p>
</div>
<div class="paragraph">
<p>The <code>enable-secure-admin</code> subcommand fails if any administrative user in
the domain has a blank password.</p>
</div>
<div class="paragraph">
<p>Alternatively, you can use the <code>enable-secure-admin-internal-user</code>
subcommand to cause the servers to identify themselves using a secure
admin user name and password.</p>
</div>
<div id="sthref1130" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--adminalias</code></dt>
<dd>
<p>The alias that refers to the SSL/TLS certificate on the DAS. This
alias is used by the DAS to identify itself to instances. The default
value is <code>s1as</code>.</p>
</dd>
<dt class="hdlist1"><code>--instancealias</code></dt>
<dd>
<p>The alias that refers to the SSL/TLS certificate on the instances.
This alias is used by the instances to identify themselves to the DAS.
The default value is <code>glassfish-instance</code>.</p>
</dd>
</dl>
</div>
<div id="sthref1131" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM606"></a><a id="sthref1132"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Enabling <code>secure admin</code> for a domain</p>
</div>
<div class="paragraph">
<p>The following example shows how to enable <code>secure admin</code> for a domain
using an admin alias <code>adtest</code> and an instance alias <code>intest</code></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; enable-secure-admin --adminalias adtest --instancealias intest
server-config
default-config

Command enable-secure-admin executed successfully.</code></pre>
</div>
</div>
<div id="sthref1133" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>subcommand executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the subcommand</p>
</dd>
</dl>
</div>
<div id="sthref1134" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="disable-secure-admin.html#disable-secure-admin-1"><code>disable-secure-admin</code>(1)</a>,
<a href="enable-secure-admin-principal.html#enable-secure-admin-principal-1"><code>enable-secure-admin-principal</code>(1)</a>,
<a href="enable-secure-admin-internal-user.html#enable-secure-admin-internal-user-1"><code>enable-secure-admin-internal-user</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="enable-monitoring.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="enable-secure-admin-internal-user.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
